docs: update bazel README to include virtualenv#5864
Merged
htuch merged 6 commits intoenvoyproxy:masterfrom Feb 8, 2019
Merged
docs: update bazel README to include virtualenv#5864htuch merged 6 commits intoenvoyproxy:masterfrom
htuch merged 6 commits intoenvoyproxy:masterfrom
Conversation
Signed-off-by: Frank Fort <ffort@google.com>
Signed-off-by: Frank Fort <ffort@google.com>
Signed-off-by: Frank Fort <ffort@google.com>
Signed-off-by: Frank Fort <ffort@google.com>
htuch
reviewed
Feb 6, 2019
bazel/README.md
Outdated
| and also for [Buildifer](https://github.com/bazelbuild/buildtools) which is used for formatting bazel BUILD files. | ||
| 1. `go get -u github.com/bazelbuild/buildtools/buildifier` to install buildifier. You may need to set `BUILDIFIER_BIN` to `$GOPATH/bin/buildifier` | ||
| in your shell for buildifier to work. | ||
| 1. `sudo apt-get install virtualenv` to install virtualenv (needed by `buildifier`). |
Member
There was a problem hiding this comment.
Why not list this above in the apt-get list for (2)?
Contributor
Author
There was a problem hiding this comment.
Mostly to distinguish things needed for building envoy vs developer tooling. It might even be clearer to fork out this section into things needed for building Envoy vs things needed for contributing to Envoy
Member
There was a problem hiding this comment.
Yeah, we don't really have this separation today, e.g. clang-format is in the first list. Since this section is titled "Quick start Bazel for developers", it's probably best to just put all the developer tooling in the main list.
Signed-off-by: Frank Fort <ffort@google.com>
htuch
approved these changes
Feb 8, 2019
fredlas
pushed a commit
to fredlas/envoy
that referenced
this pull request
Mar 5, 2019
Using buildifier failed without virtualenv so noting in the bazel README file. Also did some cleanup of the ordered list to always use "1.", see https://guides.github.com/features/mastering-markdown/#syntax. Risk Level: Low Signed-off-by: Frank Fort <ffort@google.com> Signed-off-by: Fred Douglas <fredlas@google.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description: Using buildifier failed without virtualenv so noting in the bazel README file. Also did some cleanup of the ordered list to always use "1.", see https://guides.github.com/features/mastering-markdown/#syntax.
Risk Level: Low
Testing:
Docs Changes: N/A
Release Notes: N/A